/*
 * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1980, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)route.h	8.3 (Berkeley) 4/19/94
 * $FreeBSD: src/sys/net/route.h,v 1.36.2.1 2000/08/16 06:14:23 jayanth Exp $
 */

#ifndef _NET_ROUTE_H_
#define _NET_ROUTE_H_
#include <stdint.h>
#include <sys/appleapiopts.h>
#include <sys/socket.h>
#include <sys/types.h>

/*
 * Kernel resident routing tables.
 *
 * The routing tables are initialized when interface addresses
 * are set by making entries for all directly connected interfaces.
 */

/*
 * A route consists of a destination address and a reference
 * to a routing entry.  These are often held by protocols
 * in their control blocks, e.g. inpcb.
 */
#ifdef PRIVATE
struct rtentry;
struct route {
  /*
   * N.B: struct route must begin with ro_rt and ro_flags
   * because the code does some casts of a 'struct route_in6 *'
   * to a 'struct route *'.
   */
  struct rtentry *ro_rt;
  uint32_t ro_flags; /* route flags (see below) */
  struct sockaddr ro_dst;
};

#define ROF_SRCIF_SELECTED 0x1 /* source interface was selected */

#else
struct route;
#endif /* PRIVATE */

/*
 * These numbers are used by reliable protocols for determining
 * retransmission behavior and are included in the routing structure.
 */
struct rt_metrics {
  u_int32_t rmx_locks;     /* Kernel must leave these values alone */
  u_int32_t rmx_mtu;       /* MTU for this path */
  u_int32_t rmx_hopcount;  /* max hops expected */
  int32_t rmx_expire;      /* lifetime for route, e.g. redirect */
  u_int32_t rmx_recvpipe;  /* inbound delay-bandwidth product */
  u_int32_t rmx_sendpipe;  /* outbound delay-bandwidth product */
  u_int32_t rmx_ssthresh;  /* outbound gateway buffer limit */
  u_int32_t rmx_rtt;       /* estimated round trip time */
  u_int32_t rmx_rttvar;    /* estimated rtt variance */
  u_int32_t rmx_pksent;    /* packets sent using this route */
  u_int32_t rmx_filler[4]; /* will be used for T/TCP later */
};

/*
 * rmx_rtt and rmx_rttvar are stored as microseconds;
 */
#define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */

/*
 * We distinguish between routes to hosts and routes to networks,
 * preferring the former if available.  For each route we infer
 * the interface to use from the gateway address supplied when
 * the route was entered.  Routes that forward packets through
 * gateways are marked so that the output routines know to address the
 * gateway rather than the ultimate destination.
 */
#ifdef KERNEL_PRIVATE
#include <kern/locks.h>
#ifndef RNF_NORMAL
#include <net/radix.h>
#endif
/*
 * Kernel routing entry structure (private).
 */
struct rtentry {
  struct radix_node rt_nodes[2]; /* tree glue, and other values */
#define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
#define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
  struct sockaddr *rt_gateway;    /* value */
  int32_t rt_refcnt;              /* # held references */
  uint32_t rt_flags;              /* up/down?, host/net */
  struct ifnet *rt_ifp;           /* the answer: interface to use */
  struct ifaddr *rt_ifa;          /* the answer: interface addr to use */
  struct sockaddr *rt_genmask;    /* for generation of cloned routes */
  void *rt_llinfo;                /* pointer to link level info cache */
  void (*rt_llinfo_free)(void *); /* link level info free function */
  struct rt_metrics rt_rmx;       /* metrics used by rx'ing protocols */
  struct rtentry *rt_gwroute;     /* implied entry for gatewayed routes */
  struct rtentry *rt_parent;      /* cloning parent of this route */
  uint32_t generation_id;         /* route generation id */
  /*
   * See bsd/net/route.c for synchronization notes.
   */
  decl_lck_mtx_data(, rt_lock); /* lock for routing entry */
};
#endif /* KERNEL_PRIVATE */

#ifdef KERNEL_PRIVATE
#define rt_use rt_rmx.rmx_pksent
#endif /* KERNEL_PRIVATE */

#define RTF_UP 0x1           /* route usable */
#define RTF_GATEWAY 0x2      /* destination is a gateway */
#define RTF_HOST 0x4         /* host entry (net otherwise) */
#define RTF_REJECT 0x8       /* host or net unreachable */
#define RTF_DYNAMIC 0x10     /* created dynamically (by redirect) */
#define RTF_MODIFIED 0x20    /* modified dynamically (by redirect) */
#define RTF_DONE 0x40        /* message confirmed */
#define RTF_DELCLONE 0x80    /* delete cloned route */
#define RTF_CLONING 0x100    /* generate new routes on use */
#define RTF_XRESOLVE 0x200   /* external daemon resolves name */
#define RTF_LLINFO 0x400     /* generated by link layer (e.g. ARP) */
#define RTF_STATIC 0x800     /* manually added */
#define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
#define RTF_PROTO2 0x4000    /* protocol specific routing flag */
#define RTF_PROTO1 0x8000    /* protocol specific routing flag */

#define RTF_PRCLONING 0x10000   /* protocol requires cloning */
#define RTF_WASCLONED 0x20000   /* route generated through cloning */
#define RTF_PROTO3 0x40000      /* protocol specific routing flag */
                                /* 0x80000 unused */
#define RTF_PINNED 0x100000     /* future use */
#define RTF_LOCAL 0x200000      /* route represents a local address */
#define RTF_BROADCAST 0x400000  /* route represents a bcast address */
#define RTF_MULTICAST 0x800000  /* route represents a mcast address */
#define RTF_IFSCOPE 0x1000000   /* has valid interface scope */
#define RTF_CONDEMNED 0x2000000 /* defunct; no longer modifiable */
                                /* 0x4000000 and up unassigned */

/*
 * Routing statistics.
 */
struct rtstat {
  short rts_badredirect; /* bogus redirect calls */
  short rts_dynamic;     /* routes created by redirects */
  short rts_newgateway;  /* routes modified by redirects */
  short rts_unreach;     /* lookups which failed */
  short rts_wildcard;    /* lookups satisfied by a wildcard */
};

/*
 * Structures for routing messages.
 */
struct rt_msghdr {
  u_short rtm_msglen;        /* to skip over non-understood messages */
  u_char rtm_version;        /* future binary compatibility */
  u_char rtm_type;           /* message type */
  u_short rtm_index;         /* index for associated ifp */
  int rtm_flags;             /* flags, incl. kern & message, e.g. DONE */
  int rtm_addrs;             /* bitmask identifying sockaddrs in msg */
  pid_t rtm_pid;             /* identify sender */
  int rtm_seq;               /* for sender to identify action */
  int rtm_errno;             /* why failed */
  int rtm_use;               /* from rtentry */
  u_int32_t rtm_inits;       /* which metrics we are initializing */
  struct rt_metrics rtm_rmx; /* metrics themselves */
};

struct rt_msghdr2 {
  u_short rtm_msglen;        /* to skip over non-understood messages */
  u_char rtm_version;        /* future binary compatibility */
  u_char rtm_type;           /* message type */
  u_short rtm_index;         /* index for associated ifp */
  int rtm_flags;             /* flags, incl. kern & message, e.g. DONE */
  int rtm_addrs;             /* bitmask identifying sockaddrs in msg */
  int32_t rtm_refcnt;        /* reference count */
  int rtm_parentflags;       /* flags of the parent route */
  int rtm_reserved;          /* reserved field set to 0 */
  int rtm_use;               /* from rtentry */
  u_int32_t rtm_inits;       /* which metrics we are initializing */
  struct rt_metrics rtm_rmx; /* metrics themselves */
};

#define RTM_VERSION 5 /* Up the ante and ignore older versions */

/*
 * Message types.
 */
#define RTM_ADD 0x1       /* Add Route */
#define RTM_DELETE 0x2    /* Delete Route */
#define RTM_CHANGE 0x3    /* Change Metrics or flags */
#define RTM_GET 0x4       /* Report Metrics */
#define RTM_LOSING 0x5    /* Kernel Suspects Partitioning */
#define RTM_REDIRECT 0x6  /* Told to use different route */
#define RTM_MISS 0x7      /* Lookup failed on this address */
#define RTM_LOCK 0x8      /* fix specified metrics */
#define RTM_OLDADD 0x9    /* caused by SIOCADDRT */
#define RTM_OLDDEL 0xa    /* caused by SIOCDELRT */
#define RTM_RESOLVE 0xb   /* req to resolve dst to LL addr */
#define RTM_NEWADDR 0xc   /* address being added to iface */
#define RTM_DELADDR 0xd   /* address being removed from iface */
#define RTM_IFINFO 0xe    /* iface going up/down etc. */
#define RTM_NEWMADDR 0xf  /* mcast group membership being added to if */
#define RTM_DELMADDR 0x10 /* mcast group membership being deleted */
#ifdef PRIVATE
#define RTM_GET_SILENT 0x11
#endif                     /* PRIVATE */
#define RTM_IFINFO2 0x12   /* */
#define RTM_NEWMADDR2 0x13 /* */
#define RTM_GET2 0x14      /* */

/*
 * Bitmask values for rtm_inits and rmx_locks.
 */
#define RTV_MTU 0x1       /* init or lock _mtu */
#define RTV_HOPCOUNT 0x2  /* init or lock _hopcount */
#define RTV_EXPIRE 0x4    /* init or lock _expire */
#define RTV_RPIPE 0x8     /* init or lock _recvpipe */
#define RTV_SPIPE 0x10    /* init or lock _sendpipe */
#define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
#define RTV_RTT 0x40      /* init or lock _rtt */
#define RTV_RTTVAR 0x80   /* init or lock _rttvar */

/*
 * Bitmask values for rtm_addrs.
 */
#define RTA_DST 0x1     /* destination sockaddr present */
#define RTA_GATEWAY 0x2 /* gateway sockaddr present */
#define RTA_NETMASK 0x4 /* netmask sockaddr present */
#define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
#define RTA_IFP 0x10    /* interface name sockaddr present */
#define RTA_IFA 0x20    /* interface addr sockaddr present */
#define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
#define RTA_BRD 0x80    /* for NEWADDR, broadcast or p-p dest addr */

/*
 * Index offsets for sockaddr array for alternate internal encoding.
 */
#define RTAX_DST 0     /* destination sockaddr present */
#define RTAX_GATEWAY 1 /* gateway sockaddr present */
#define RTAX_NETMASK 2 /* netmask sockaddr present */
#define RTAX_GENMASK 3 /* cloning mask sockaddr present */
#define RTAX_IFP 4     /* interface name sockaddr present */
#define RTAX_IFA 5     /* interface addr sockaddr present */
#define RTAX_AUTHOR 6  /* sockaddr for author of redirect */
#define RTAX_BRD 7     /* for NEWADDR, broadcast or p-p dest addr */
#define RTAX_MAX 8     /* size of array to allocate */

struct rt_addrinfo {
  int rti_addrs;
  struct sockaddr *rti_info[RTAX_MAX];
};

struct route_cb {
  int ip_count;
  int ip6_count;
  int ipx_count;
  int ns_count;
  int iso_count;
  int any_count;
};

#ifdef PRIVATE
/*
 * For scoped routing; a zero interface scope value means nil/no scope.
 */
#define IFSCOPE_NONE 0
#endif /* PRIVATE */

#ifdef KERNEL_PRIVATE
/*
 * Generic call trace used by some subsystems (e.g. route, ifaddr)
 */
#define CTRACE_STACK_SIZE 8 /* depth of stack trace */
#define CTRACE_HIST_SIZE 4  /* refcnt history size */
typedef struct ctrace {
  void *th;                    /* thread ptr */
  void *pc[CTRACE_STACK_SIZE]; /* PC stack trace */
} ctrace_t;

extern void ctrace_record(ctrace_t *);

#define RT_LOCK_ASSERT_HELD(_rt)                                               \
  lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_OWNED)

#define RT_LOCK_ASSERT_NOTHELD(_rt)                                            \
  lck_mtx_assert(&(_rt)->rt_lock, LCK_MTX_ASSERT_NOTOWNED)

#define RT_LOCK(_rt)                                                           \
  do {                                                                         \
    if (!rte_debug)                                                            \
      lck_mtx_lock(&(_rt)->rt_lock);                                           \
    else                                                                       \
      rt_lock(_rt, FALSE);                                                     \
  } while (0)

#define RT_LOCK_SPIN(_rt)                                                      \
  do {                                                                         \
    if (!rte_debug)                                                            \
      lck_mtx_lock_spin(&(_rt)->rt_lock);                                      \
    else                                                                       \
      rt_lock(_rt, TRUE);                                                      \
  } while (0)

#define RT_CONVERT_LOCK(_rt)                                                   \
  do {                                                                         \
    RT_LOCK_ASSERT_HELD(_rt);                                                  \
    lck_mtx_convert_spin(&(_rt)->rt_lock);                                     \
  } while (0)

#define RT_UNLOCK(_rt)                                                         \
  do {                                                                         \
    if (!rte_debug)                                                            \
      lck_mtx_unlock(&(_rt)->rt_lock);                                         \
    else                                                                       \
      rt_unlock(_rt);                                                          \
  } while (0)

#define RT_ADDREF_LOCKED(_rt)                                                  \
  do {                                                                         \
    if (!rte_debug) {                                                          \
      RT_LOCK_ASSERT_HELD(_rt);                                                \
      if (++(_rt)->rt_refcnt == 0)                                             \
        panic("RT_ADDREF(%p) bad refcnt\n", _rt);                              \
    } else {                                                                   \
      rtref(_rt);                                                              \
    }                                                                          \
  } while (0)

/*
 * Spin variant mutex is used here; caller is responsible for
 * converting any previously-held similar lock to full mutex.
 */
#define RT_ADDREF(_rt)                                                         \
  do {                                                                         \
    RT_LOCK_SPIN(_rt);                                                         \
    RT_ADDREF_LOCKED(_rt);                                                     \
    RT_UNLOCK(_rt);                                                            \
  } while (0)

#define RT_REMREF_LOCKED(_rt)                                                  \
  do {                                                                         \
    if (!rte_debug) {                                                          \
      RT_LOCK_ASSERT_HELD(_rt);                                                \
      if ((_rt)->rt_refcnt == 0)                                               \
        panic("RT_REMREF(%p) bad refcnt\n", _rt);                              \
      --(_rt)->rt_refcnt;                                                      \
    } else {                                                                   \
      (void)rtunref(_rt);                                                      \
    }                                                                          \
  } while (0)

/*
 * Spin variant mutex is used here; caller is responsible for
 * converting any previously-held similar lock to full mutex.
 */
#define RT_REMREF(_rt)                                                         \
  do {                                                                         \
    RT_LOCK_SPIN(_rt);                                                         \
    RT_REMREF_LOCKED(_rt);                                                     \
    RT_UNLOCK(_rt);                                                            \
  } while (0)

#define RTFREE(_rt) rtfree(_rt)
#define RTFREE_LOCKED(_rt) rtfree_locked(_rt)

extern struct route_cb route_cb;
extern struct radix_node_head *rt_tables[AF_MAX + 1];
__private_extern__ lck_mtx_t *rnh_lock;
__private_extern__ int use_routegenid;
__private_extern__ uint32_t route_generation;
__private_extern__ int rttrash;
__private_extern__ unsigned int rte_debug;

struct ifmultiaddr;
struct proc;

extern void route_init(void) __attribute__((section("__TEXT, initcode")));
extern void routegenid_update(void);
extern void rt_ifmsg(struct ifnet *);
extern void rt_missmsg(int, struct rt_addrinfo *, int, int);
extern void rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
extern void rt_newmaddrmsg(int, struct ifmultiaddr *);
extern int rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
extern void set_primary_ifscope(unsigned int);
extern unsigned int get_primary_ifscope(void);
extern boolean_t rt_inet_default(struct rtentry *, struct sockaddr *);
extern struct rtentry *rt_lookup(boolean_t, struct sockaddr *,
                                 struct sockaddr *, struct radix_node_head *,
                                 unsigned int);
extern void rtalloc(struct route *);
extern void rtalloc_ign(struct route *, uint32_t);
extern void rtalloc_ign_locked(struct route *, uint32_t);
extern void rtalloc_scoped_ign(struct route *, uint32_t, unsigned int);
extern void rtalloc_scoped_ign_locked(struct route *, uint32_t, unsigned int);
extern struct rtentry *rtalloc1(struct sockaddr *, int, uint32_t);
extern struct rtentry *rtalloc1_locked(struct sockaddr *, int, uint32_t);
extern struct rtentry *rtalloc1_scoped(struct sockaddr *, int, uint32_t,
                                       unsigned int);
extern struct rtentry *rtalloc1_scoped_locked(struct sockaddr *, int, uint32_t,
                                              unsigned int);
extern void rtfree(struct rtentry *);
extern void rtfree_locked(struct rtentry *);
extern void rtref(struct rtentry *);
/*
 * rtunref will decrement the refcount, rtfree will decrement and free if
 * the refcount has reached zero and the route is not up.
 * Unless you have good reason to do otherwise, use rtfree.
 */
extern int rtunref(struct rtentry *);
extern void rtsetifa(struct rtentry *, struct ifaddr *);
extern int rtinit(struct ifaddr *, int, int);
extern int rtinit_locked(struct ifaddr *, int, int);
extern int rtioctl(unsigned long, caddr_t, struct proc *);
extern void rtredirect(struct ifnet *, struct sockaddr *, struct sockaddr *,
                       struct sockaddr *, int, struct sockaddr *,
                       struct rtentry **);
extern int rtrequest(int, struct sockaddr *, struct sockaddr *,
                     struct sockaddr *, int, struct rtentry **);
extern int rtrequest_locked(int, struct sockaddr *, struct sockaddr *,
                            struct sockaddr *, int, struct rtentry **);
extern int rtrequest_scoped_locked(int, struct sockaddr *, struct sockaddr *,
                                   struct sockaddr *, int, struct rtentry **,
                                   unsigned int);
extern unsigned int sa_get_ifscope(struct sockaddr *);
extern void rt_lock(struct rtentry *, boolean_t);
extern void rt_unlock(struct rtentry *);
extern struct sockaddr *rtm_scrub_ifscope(int, struct sockaddr *,
                                          struct sockaddr *,
                                          struct sockaddr_storage *);
#endif /* KERNEL_PRIVATE */

#endif
